home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rahelp11.zip / RAHELP.DOC < prev    next >
Text File  |  1992-04-02  |  6KB  |  136 lines
  1. RAHelp v1.10
  2. Help/TextFile Full-Screen Driver
  3. Written by Ken Reily and Chris Bongaarts
  4.  
  5. Gotta get this outta the way...
  6.  
  7. If any computer related component blows up, it's not my fault.
  8.  
  9. Ok, now to the fun stuff...
  10.  
  11. What is it: It's a program!
  12.  
  13. Besides that: It's a full-screen text(help) file driver for RA or
  14. QuickBBS. It was intended for scrolling through help files, but it can
  15. be used for just about anything.
  16.  
  17. Installation...
  18.  
  19. Ok, here's basically how it works. UnZIP this archive into a separate directory
  20. on your HD. Put the RAHELP.CFG file in the path that RAHELP will be called from
  21. (usually the RA system directory or, if using a type 15 exit, wherever you
  22. decide to CD to in your batch file.) You should call this from a type 7 menu
  23. item in RA (Or type 15 for patient people). Since this program is not exactly
  24. memory efficient, we strongly suggest you use the swap to disk function. Call
  25. RAHELP from your menu item's
  26.  
  27. Optional Data line like this:
  28.  
  29.    <path>RAHELP.EXE*M <FILENAME> [DEBUG]
  30.  
  31. Where: RAHELP.EXE is the program.
  32.  
  33.        <FILENAME> is the file name to display before the
  34.                   main menu. This is usually the help file for the
  35.                   current area the user is in. This file need not be
  36.                   in the RAHELP.DAT file.
  37.  
  38.        [DEBUG]    is a parameter that will cause the program to stop
  39.                   and display all system variables. Use this if you
  40.                   think that something is not being read correctly
  41.                   from the config file.
  42.  
  43.                   *M, of course, indicates the Swap function.
  44.  
  45. The two Data files you will need are RAHELP.CFG, the configuration file, and
  46. RAHELP.DAT, the file containing the files to be displayed and their
  47. descriptions. Let's go through RAHELP.CFG.
  48.  
  49. RAHELP.CFG is the configuration file. This must be placed in the
  50. directory that RAHelp is called from. This is the first file RAHelp will
  51. read, and contains all the names of operating directories that will be
  52. used in the course of the programs operation. Please refer to
  53. instructions placed inside the config file. All lines beginning with ;'s
  54. are ignored.
  55.  
  56. The RAHELP.DAT file is basically your menu file. It is entered as an ASCII text
  57. file in the following format:
  58.  
  59. Column 1        Column 15
  60. MSGHELP         Help Entering Messages
  61. FILEHELP        Help with File XFers
  62. DISCLAIM.TXT    Disclaimer! Read this!
  63.  
  64. The file to display, extension or no extension, should begin on column one(1).
  65. The description (What actually appears on the main menu) should start at column
  66. 15 and go through column 72. Any ASCII text can be entered for either of these.
  67. If there is no extension specified, then .ASC or .ANS is used depending on the
  68. status of the users ANSI bit. You may have up to 100 help files in RAHELP.DAT
  69. as of this writing. Future versions may include formatting of menus, thus
  70. shortening the description length;  you should plan your descriptions
  71. accordingly.
  72.  
  73. RAHelp has been successfully tested on a 80386sx-16, a 4.77Mhz PC, and a
  74. 80386dx-40. If you expierience problems with your machine, or if you
  75. find the speed of the program(over the modem) unsatisfactory, please let
  76. us know on the comment line of your registration form.
  77.  
  78. This program could not have been possible in its entirety without the
  79. help and suggestions of beta testers. For this, I would like to thank
  80. Greg Jansen of Muddy Waters BBS for being the lone Beta Tester for the
  81. first version. If you would like to beta test for this program, please
  82. leave a message to me at the address below, or include it on your
  83. suggestions line.
  84.  
  85. Please make sure that all your ANSI screens are saved without screen
  86. mode manipulation commands. Commands that clear the screen and move the
  87. cursor around tend to make RAHelp lose its place. We would put in a
  88. filter for these characters, but then that causes the display to lose
  89. alot of speed. If you are expieriencing problems with these, take out
  90. those codes. Also be sure and save all ANSI screens with NO maximum line
  91. length, this causes a great speed increase in RAHelp.
  92.  
  93. Another suggestion for a speed increase. Before the program is run,
  94. execute the command SET OUTBUFF=ON. This will cause outbound buffering
  95. and allow for a great speed increase. Set this to off after you are
  96. finished.
  97.  
  98. Registration of this program as of v1.0 costs only $5. Future versions
  99. may have increased registration fees, so getting your registration
  100. number now insures minnimum investment. Your registration number will be
  101. good for all future versions of RAHelp. Send $5 check or money order
  102. with the registration form to:
  103.  
  104.         Ken Reily
  105.         8432 Virginia Rd.
  106.         Bloomington, MN  55438
  107.  
  108. Thanks to:
  109.  
  110. John Parlin (Author of JPDoor) for his perserverence in answering my
  111.    stupid questions, and for making this program so much easier to
  112.    bring to you
  113.  
  114. John Jacobs for being a great guy, and lending a routine or two
  115.  
  116. All the users of "The Game Center BBS" for helping me during the
  117.    seemingly endless period of testing and re-working
  118.  
  119. Michael Bolton, Amy Grant, Steven Spielberg, and Hans Zimmer
  120.    for providing the entertainment that keeps me out of the
  121.    nuthouse while working on this...
  122.  
  123. Greg Jansen of Muddy Waters BBS for keeping me REALLY busy on his many
  124.    suggestions for this, some of which have not been implemented as of
  125.    this version.
  126.  
  127. For more info, comments, suggestions, a good
  128. conversation, and a great time, call
  129.  
  130. The Game Center BBS   (612) 942-7531
  131. 9600 baud -- 24 hours
  132.  
  133. FidoNet 1:282/54
  134. MetroNet 200:5005/13
  135. SpudNet 103:1001/11
  136.